eric7.QtHelpInterface.HelpDocsInstaller

Module implementing a thread class populating and updating the QtHelp documentation database.

Global Attributes

None

Classes

HelpDocsInstaller Class implementing the worker thread populating and updating the QtHelp documentation database.

Functions

None

HelpDocsInstaller

Class implementing the worker thread populating and updating the QtHelp documentation database.

Signals

docsInstalled(bool)
emitted after the installation has finished
errorMessage(str)
emitted, if an error occurred during the installation of the documentation

Derived from

QThread

Class Attributes

None

Class Methods

None

Methods

HelpDocsInstaller Constructor
__installEric7Doc Private method to install/update the eric help documentation.
installDocs Public method to start the installation procedure.
run Public method executed by the thread.
stop Public slot to stop the installation procedure.

Static Methods

None

HelpDocsInstaller (Constructor)

HelpDocsInstaller(collection)

Constructor

collection (str)
full pathname of the collection file

HelpDocsInstaller.__installEric7Doc

__installEric7Doc(engine)

Private method to install/update the eric help documentation.

engine (QHelpEngineCore)
reference to the help engine
Return:
flag indicating success
Return Type:
bool

HelpDocsInstaller.installDocs

installDocs()

Public method to start the installation procedure.

HelpDocsInstaller.run

run()

Public method executed by the thread.

HelpDocsInstaller.stop

stop()

Public slot to stop the installation procedure.

Up